Interface NATProcess

All Superinterfaces:
IPCObject, Process
All Known Subinterfaces:
AsaNatProcess, AsaNatv6Process
All Known Implementing Classes:
AsaNatProcessImpl, AsaNatv6ProcessImpl, NATProcessImpl

public interface NATProcess extends Process
Information provided by the PKI file:

    \class NatProcess
    
    \brief NatProcess handles and manipulates the NAT process.
    
    \example network().getDevice("Router0").getProcess("NatProcess")
    
Author:
Auto-generated
  • Method Details

    • addNatPool

      boolean addNatPool(String poolName)
      Information provided by the PKI file:
      
          \brief Adds a NAT pool with the specified name.
          
          \param poolName, the name for the NAT pool.
          
          \return bool, true if successful, otherwise false.
          
              
      Parameters:
      poolName - Takes in a parameter of poolName
      Returns:
      boolean Returns a boolean
    • getNatPool

      NATPool getNatPool(String poolName)
      Information provided by the PKI file:
      
          \brief Returns the NAT pool with the specified name.
          
          \param poolName, the name of the NAT pool of interest.
          
          \return NatPool, the NatPool object with the specified name.
          
              
      Parameters:
      poolName - Takes in a parameter of poolName
      Returns:
      NATPool Returns a NATPool
    • getNatPoolAt

      NATPool getNatPoolAt(int index)
      Information provided by the PKI file:
      
          \brief Returns the NAT pool at the specified index.
          
          \param index, the index of the NAT pool of interest.
          
          \return NatPool, the NatPool object at the specified index.
          
              
      Parameters:
      index - Takes in a parameter of index
      Returns:
      NATPool Returns a NATPool
    • removeNatPool

      boolean removeNatPool(String poolName)
      Information provided by the PKI file:
      
          \brief Removes the NAT pool with the specified name.
          
          \param poolName, the name of the NAT pool.
          
          \return bool, true if successful, otherwise false.
          
              
      Parameters:
      poolName - Takes in a parameter of poolName
      Returns:
      boolean Returns a boolean
    • getNatPoolCount

      int getNatPoolCount()
      Information provided by the PKI file:
      
          \brief Returns the number of NAT pools.
          
          \return int, the number of NAT pools.
          
              
      Returns:
      int Returns a int
    • getInSrcStaticCount

      int getInSrcStaticCount()
      Information provided by the PKI file:
      
          \brief Returns the number of inside source static entries.
          
          \return int, the number of inside source static entries.
          
              
      Returns:
      int Returns a int
    • getOutSrcStaticCount

      int getOutSrcStaticCount()
      Information provided by the PKI file:
      
          \brief Returns the number of outside source static entries.
          
          \return int, the number of outside source static entries.
          
              
      Returns:
      int Returns a int
    • getInSrcStaticAt

      NATEntry getInSrcStaticAt(int index)
      Information provided by the PKI file:
      
          \brief Returns the inside source static entry at the specified index.
          
          \param index, the index of the inside source static entry of interest.
          
          \return NatEntry, the NatEntry object at the specified index.
          
              
      Parameters:
      index - Takes in a parameter of index
      Returns:
      NATEntry Returns a NATEntry
    • getOutSrcStaticAt

      NATEntry getOutSrcStaticAt(int index)
      Information provided by the PKI file:
      
          \brief Returns the inside source static entry at the specified index.
          
          \param index, the index of the inside source static entry of interest.
          
          \return NatEntry, the NatEntry object at the specified index.
          
              
      Parameters:
      index - Takes in a parameter of index
      Returns:
      NATEntry Returns a NATEntry
    • clearAllTranslations

      void clearAllTranslations()
      Information provided by the PKI file:
      
          \brief Clears all NAT translations.
          
              
    • removeInSrcList

      boolean removeInSrcList(String aclId)
      Information provided by the PKI file:
      
          \brief Removes the inside source list entry with the specified ACL ID.
          
          \param aclId, the ID of the ACL of interest.
          
          \return bool, true if successful, otherwise false.
          
              
      Parameters:
      aclId - Takes in a parameter of aclId
      Returns:
      boolean Returns a boolean
    • removeOutSrcList

      boolean removeOutSrcList(String aclId)
      Information provided by the PKI file:
      
          \brief Removes the outside source list entry with the specified ACL ID.
          
          \param aclId, the ID of the ACL of interest.
          
          \return bool, true if successful, otherwise false.
          
              
      Parameters:
      aclId - Takes in a parameter of aclId
      Returns:
      boolean Returns a boolean
    • getInSrcList

      NATList getInSrcList(String aclId)
      Information provided by the PKI file:
      
          \brief Returns the inside source list entry with the specified ACL ID.
          
          \param aclId, the ID of the ACL of interest.
          
          \return NatEntry, the NatEntry object with the specified ACL ID.
          
              
      Parameters:
      aclId - Takes in a parameter of aclId
      Returns:
      NATList Returns a NATList
    • getOutSrcList

      NATList getOutSrcList(String aclId)
      Information provided by the PKI file:
      
          \brief Returns the outside source list entry with the specified ACL ID.
          
          \param aclId, the ID of the ACL of interest.
          
          \return NatEntry, the NatEntry object with the specified ACL ID.
          
              
      Parameters:
      aclId - Takes in a parameter of aclId
      Returns:
      NATList Returns a NATList
    • getInSrcListAt

      NATList getInSrcListAt(int index)
      Information provided by the PKI file:
      
          \brief Returns the inside source list entry at the specified index.
          
          \param index, the index of the inside source list entry of interest.
          
          \return NatEntry, the NatEntry object at the specified index.
          
              
      Parameters:
      index - Takes in a parameter of index
      Returns:
      NATList Returns a NATList
    • getOutSrcListAt

      NATList getOutSrcListAt(int index)
      Information provided by the PKI file:
      
          \brief Returns the outside source list entry at the specified index.
          
          \param index, the index of the outside source list entry of interest.
          
          \return NatEntry, the NatEntry object at the specified index.
          
              
      Parameters:
      index - Takes in a parameter of index
      Returns:
      NATList Returns a NATList
    • getInSrcListCount

      int getInSrcListCount()
      Information provided by the PKI file:
      
          \brief Returns the number of inside source list entries.
          
          \return int, the number of inside source list entries.
          
              
      Returns:
      int Returns a int
    • getOutSrcListCount

      int getOutSrcListCount()
      Information provided by the PKI file:
      
          \brief Returns the number of outside source list entries.
          
          \return int, the number of outside source list entries.
          
              
      Returns:
      int Returns a int
    • getNatTable

      NATTable getNatTable()
      Information provided by the PKI file:
      
          \brief Returns the NAT table.
          
          \return NatTable, the NatTable object.
          
              
      Returns:
      NATTable Returns a NATTable